home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #14 / Monster Media No. 14 (April 1996) (Monster Media, Inc.).ISO / bbs_door / remind19.zip / REMINDME.DOC < prev    next >
Text File  |  1996-01-15  |  18KB  |  415 lines
  1.  
  2.                                REMIND ME !
  3.  
  4.                                   v1.9
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                          (404) 256-9525 (Data)
  12.                          (404) 705-9104 (Data)
  13.                 (404) 256-9518 (Voice, 9am-9:30pm EST)
  14.                      (Email) al_lawre@ix.netcom.com
  15.  
  16.  
  17.  
  18.                                 OVERVIEW
  19.                                 ________
  20.  
  21.  
  22.    The REMIND ME! Door allows your callers to enter REMINDERS to themselves.
  23.    They can be reminded daily, on a specific date, a day of the week, on a
  24.    paricular date of the month OR on EVEN or ODD days of the month (in
  25.    essence displaying the Reminder every other day). Reminders are displayed
  26.    to the caller when they open the Door or automatically if you make it an
  27.    Auto Login Door.
  28.  
  29.    SYSOP can leave reminders to ALL, specific Security levels or to
  30.    SPECIFIC USERS!!!!
  31.  
  32.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  33.          created in the directory you run the door from.
  34.  
  35.  
  36.  
  37.                               INSTALLATION
  38.                               ____________
  39.  
  40.  
  41.    Installation is fairly easy and straight-forward. The following steps and
  42.    examples should have you up and running in a very short period of time.
  43.    It is assumed that you are familiar with setting up DOORS on your system.
  44.    To this end, only examples of the configuration file and Door batch file
  45.    are described.
  46.  
  47.       1) Create a directory to hold all REMINDME files
  48.  
  49.       2) Unzip REMINDxx.ZIP into the the above directory
  50.  
  51.       3) Create a configuration file, with a name of your choice, or
  52.          modify the supplied REMINDME.CFG file. A description follows:
  53.  
  54.             **                       Location of system file (See Below)
  55.             SUNRISE-80 BBS           Your BBS Name
  56.             Al                       Sysop's First name
  57.  
  58.             Lawrence                 Sysop's Last Name
  59. |-----------------------------------------------------------------------------|
  60. | READ!     1                        CommPort  \ These 2 lines are required   |
  61. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  62. |-----------------------------------------------------------------------------|
  63.  
  64.             00000000                 Registration Number
  65.  
  66.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  67.                                      2 = Display ADOPT-A-DOOR message
  68.  
  69.             2                        Keyboard timeout value in Minutes
  70.  
  71.             N                        Y =  Use European Date Format (DDMMYY)
  72.                                      N =  Use Regular  Date Format (MMDDYY)
  73.  
  74.            365                       Maximum # of days caller can enter in
  75.                                      response to the number of warning days.
  76.                                      This number will be used to determine how
  77.                                      many days prior to the due to start
  78.                                      displaying the Reminder. (0-365).
  79.                                      0 = No warning days
  80.  
  81.            365                       Maximum # of days caller can enter in
  82.                                      in response to how long the reminder
  83.                                      will remain active (1-365)
  84.  
  85.              0                       Additional Security level that will be
  86.                                      allowed to leave Reminders as if they
  87.                                      were the Sysop (Co-Sysop as an example)
  88.                                      Note: They will NOT be able to Delete or
  89.                                            Modify or Review messages they
  90.                                            entered to a Specific caller or to
  91.                                            All Callers.
  92.  
  93.              Y                       Y = Do    check if caller is ANSI capable
  94.                                      N = DoNot check if caller is ANSI capable
  95.  
  96.  
  97.           NONE                       Drive\path\filename of the file you want
  98.                                      displayed when returning from an AUTO-LOGIN
  99.                                      to the BBS.
  100.  
  101.           NONE                       Drive\Path\Filename of the file you want
  102.                                      displayed when manually exiting the Door
  103.                                      using the Exit option from the Main Menu.
  104.  
  105.              Y                       Y = FORCE callers to read ALL Reminders 
  106.                                      N = Allow callers to EXIT without reading
  107.                                          ALL Reminders
  108.  
  109.               ** = Replace with ONE of the following:
  110.  
  111. C:\BBS\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  112. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  113. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  114. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  115. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  116. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  117. C:\BBS\GTUSER.BBS               <- For GT Power
  118.                                    * if using this option you must put the
  119.                                      ComPort # on line 5 and the Node # on
  120.                                      line 6 of the configuration file
  121.  
  122.  
  123.  
  124.            # = Requires registration to change to a different value.
  125.  
  126.                NOTE: There are NO Blank Lines in the Config File!!
  127.  
  128.  
  129.  
  130.  
  131.       4) Create a batch file or modify the REMINDME file supplied. A
  132.          description of this file follows:
  133.  
  134.             ECHO off
  135.             cd\BBS\DOORS\REMINDME     Location of REMINDME files
  136.             REMINDME REMINDME.CFG     EXE filename and CFG filename (Name
  137.                                       used in creating file in #3 above)
  138.             CD\BBS
  139.             BOARD
  140.  
  141.  
  142.        5) When running in more than one node, be sure to supply a
  143.           different configuration name for each node (your choice of name).
  144.  
  145.        6) If running with Fossil-based multi-port boards add
  146.            /FD to the line containing the CFG name as follows:
  147.  
  148.                         REMINDME REMINDME.CFG /FD
  149.  
  150.  
  151.  
  152.  
  153.                           TROUBLESHOOTING
  154.                           ---------------
  155.  
  156. (1) If you are running this Door on a 486 system and encounter errors such as
  157.  
  158.     ERROR 6.... OVERFLOW Error
  159.     ERROR 5.... ILLEGAL Function Call (may be associated with other problems)
  160.     KEYBOARD Timeout after 5 minutes
  161.  
  162.     You may have to put the following line in your AUTOEXEC.BAT file:
  163.  
  164.          SET NO87=ON
  165.  
  166. (2) If you encounter an Error 62 (Input Past End of File), BEFORE you see the
  167.     opening screen of the Door, your problem will more than likely be associated
  168.     with the CFG file. The error 62 means that you do not have enough entries
  169.     in the CFG. Compare your CFG file with the CFG definition in the DOC file.
  170.  
  171.  
  172. (3) If you encounter an ERROR 70... Permission Denied, this will more than
  173.     likely mean that you DO NOT have SHARE loaded. SHARE is a DOS file that
  174.     comes with your version of DOS. To load it type the word SHARE at the DOS
  175.     prompt. To load it permanently type the word SHARE on a line by itself in
  176.     your AUTOEXEC.BAT file, any place prior to the loading of your BBS
  177.     software. There have been numerous reports that loading SHARE high causes
  178.     some problems, so to be on the safe side, do not load it high.
  179.  
  180.  
  181. Should you have any questions or problem, please do not hesitate to call
  182.    voice for immediate help... 404-256-9518 (9am-9:30pm EST) any day!
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.                              TRASHCAN File
  191.                              -------------
  192.  
  193.       If you wish to trap any words that you do not want your users to see,
  194.       such as foul language, etc, then you create an ASCII file with the word
  195.       or words. Each word must appear on a separate line, up to a maximum of
  196.       100. The name of the file must be TRASHCAN and must reside in the same
  197.       directory as the REMINDME.EXE file. The program will check ALL
  198.       description lines against the list. If a match is found the offending
  199.       word(s) will be changed to asteriks (*).
  200.  
  201.  
  202.                       AUTO LOGIN OPTION (Registered Version Only)
  203.                       -------------------------------------------
  204.  
  205.       Should you want to take your callers to the REMIND ME Door automatically
  206.       at logon I would suggest that you set up 2 batch files.
  207.  
  208.       One batch file would take the caller to the Door if they selected it off
  209.       your Door Menu. They would be presented with any Reminders that have
  210.       come due AND they will be able to use all the functions of the Door.
  211.       See #4 above for example.
  212.  
  213.       The second batch file would take your caller to the Door, present the
  214.       caller with any Reminders that have come due and immediately return to
  215.       the BBS. REMIND ME will display a file you have defined in the CFG,
  216.       while the system is returning to the BBS. All that would be required
  217.       would be to create another batch file as in #4 above, give it another
  218.       name (I use REMLOGIN, but you do what you have to depending on your
  219.       BBS software) and ADD   BYPASS   to the END of the Command line.
  220.  
  221.           Example: REMINDME REMINDME.CFG BYPASS
  222.              Note: BYPASS must be the last parameter on the line
  223.                    Everything else in the batch file is the same as #4 above
  224.  
  225.  
  226.                         NON-STANDARD COM SUPPORT
  227.                         ________________________
  228.  
  229.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  230.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  231.       number after the configuration filename. Let's assume your Door is
  232.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  233.       passed to your Door would be:
  234.  
  235.                             FOOBAR FOOBAR.CFG /5
  236.  
  237.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  238.       normally used with COM1. No /x parameter is needed for the standard
  239.       IRQ's.
  240.  
  241.       As an alternative, you may use an environmental variable on the command
  242.       line. To use the variable (following the example above), place a
  243.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  244.       different IRQ number for each node). The command line would now look
  245.       like this:
  246.  
  247.                           FOOBAR FOOBAR.CFG /%IRQ%
  248.  
  249.       This, in combination with the use of the environmental variables
  250.       described in the MULTI-NODE SETUP section will allow you to use one
  251.       batch file and one config file to run this door on all nodes.
  252.  
  253.  
  254.  
  255.  
  256.                            MULTI-NODE SETUP
  257.                            ________________
  258.  
  259.       All Sunrise Doors are Multi-Node capable. Each node must have the
  260.       ability to access a configuration file which will have its own system
  261.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  262.       line. There are 2 ways to accomplish this:
  263.  
  264.       (1) Create a separate configuration file for each node. The only
  265.           difference between each file would be the location of the system
  266.           file for that particular node. For example, on my system there are 2
  267.           nodes and the first line of the config files would look like this:
  268.  
  269.                         NODE1:  H:\PCB1\DOOR.SYS
  270.                         NODE2:  H:\PCB2\DOOR.SYS
  271.  
  272.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  273.  
  274.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  275.           the following PCBoard/Wildcat environmental variables:
  276.  
  277.                  PCBDIR    (Directory containing the System file)
  278.                  PCBDRIVE  (Drive containing the System file)
  279.                  WCNODEID  (Active Node Number)
  280.  
  281.           Thus, the first line of the SINGLE configuration file, for this Door
  282.           would look like this:
  283.  
  284.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  285.                         c:\wc30\wcwork\node%wcnodeid%\door.sys
  286.  
  287.       NOTE: This option, as described, assumes that you are running PCB or
  288.             Wildcat software. The environmental variables are automatically
  289.             created by the software for each node.
  290.  
  291.             HOWEVER, if you are running other BBS software you should be able
  292.             to set the variables EXACTLY as described below, for EACH node
  293.             (more than likely in each batch file you use to bring up EACH node):
  294.  
  295.                             PCBDRIVE=C:
  296.                             ^^^^^^^^^
  297.                             PCBDIR=\NODE2
  298.                             ^^^^^^^^
  299.  
  300.             Info with a carat (^) under it, MUST be typed as is. The rest
  301.             depends on your naming conventions.
  302.  
  303.             This, in combination with the use of the optional environmental
  304.             variable described in the NON-STANDARD COM SUPPORT section, will
  305.             allow you to use one batch file and one config file to run this
  306.             door on all nodes.
  307.  
  308.  
  309.  
  310.                                ADOPT-A-DOOR
  311.                                ____________
  312.  
  313.     Having been a Sysop for a number of years, I have had my share of problems
  314.     and frustrations getting financial support for my board's upkeep. A fellow
  315.     Sysop left a message on my board, not long ago, about a concept that was
  316.     being used by several boards around the country.
  317.  
  318.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  319.     would be the same as sending in a donation, only this way it is earmarked
  320.     for registering a particular door. In a way, the user feels he/she is
  321.     "getting something in return". As a Door author I have decided to build
  322.     this concept into each of my Door programs. The concept replaces the
  323.     usual message "tell the Sysop to register this Door" we find in most
  324.     doors.
  325.  
  326.     If the Door is unregisterd then a message appears on the opening screen
  327.     to that effect. After finishing or suspending a game, a message screen
  328.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  329.     caller to contact the Sysop to find out if there is any further details
  330.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  331.     time, etc to callers that ADOPT-A-DOOR.
  332.  
  333.     If the Door has been registered, either by the Sysop or other callers,
  334.     the names of those contributors will be displayed in the closing screen.
  335.  
  336.     NOTE: If you want to display the names of the callers that contributed
  337.           to registering the Door, you must create an ASCII file called
  338.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  339.           the name(s) of the contributors (one on each line, maximum of 5
  340.           entries, each a maximum of 30 characters long). This file must be
  341.           saved, in ASCII format, and placed in the Door directory.
  342.  
  343.  
  344.  
  345.                               LEGALITIES
  346.                               __________
  347.  
  348.  
  349.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  350.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  351.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  352.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  353.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  354.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  355.       OR BREACH OF ANY WARRANTY.
  356.  
  357.  
  358.  
  359.  
  360.  
  361.                              DISTRIBUTION
  362.                              ____________
  363.  
  364.    You may make this file available for downloading from your BBS or you may
  365.    upload it to any BBS of your choice, provided that you do not make any
  366.    changes to the contents of the archive (ZIP file). The archive and its
  367.    individual contents may not be used by any service that charges any money
  368.    whatsoever, without the written permission of the author.
  369.  
  370.  
  371.  
  372.  
  373.  
  374.                              REGISTRATION
  375.                              ____________
  376.  
  377.    Registration and the subsequent insertion of the registration number into
  378.    your configuation file, allows for the display of your BBS name on the
  379.    opening and closing screen as well as the reduction of a delay built into
  380.    the opening screen display along with the ability to change certain
  381.    values in the configuration file.
  382.  
  383.    To register your copy of REMINDME, please fill out the registration form
  384.    (REGISTER.FRM) and mail it along with the appropriate registration fee to
  385.    the name and address on the form.
  386.  
  387.    Once a door is registered, any changes to registration information (Sysop
  388.    name or BBS Name) will require the doors to be re-registered. Download or
  389.    File Request a file named CHANGE.FRM from our BBS, complete the form and
  390.    follow ALL instructions in the document!
  391.  
  392.    Registration fees are subject to change at any time. The most current
  393.    registration form is always available on our BBS. You may download or
  394.    File Request REGISTER.FRM at any time.
  395.  
  396.    Be sure to use the proper upper/lower case when filling in your name and
  397.    BBS name, as they MUST match the way you entered them in the configuration
  398.    file.             ^^^^
  399.  
  400.    Based upon information supplied on the registration form, I will pre-
  401.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  402.    up your registration number.
  403.  
  404.  
  405.  
  406.                                  MISC
  407.                                  ____
  408.  
  409.    The latest version of REMIND  ME! and other fine SUNRISE DOOR programs
  410.    are always available for download from SUNRISE-80 BBS.
  411.  
  412.    Remember, should you have any problems, questions or suggestions, be sure
  413.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  414.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.
  415.